home *** CD-ROM | disk | FTP | other *** search
/ Oh!X 2001 Spring / Oh!X 2001 Spring Special CD-ROM (Japan).7z / Oh!X 2001 Spring Special CD-ROM (Japan) (Track 1).bin / FBENC / TEC-FB^3.sea / TEC-FB^3 / TextEncodingConverter.Incl < prev    next >
Text File  |  2000-03-24  |  8KB  |  171 lines
  1. /*
  2.   File:  TextEncodingConverter.h
  3.  
  4.   Contains: Text Encoding Conversion Interfaces. 
  5.  
  6.   Version: Mac OS 8.7
  7.  
  8.   DRI:  Julio Gonzalez
  9.  
  10.   Copyright: ｩ 1994-1999 by Apple Computer, Inc., all rights reserved.
  11.  
  12.   Warning: *** APPLE INTERNAL USE ONLY ***
  13.      This file may contain unreleased API's
  14.  
  15.   BuildInfo: Built by:   BuildGod
  16.      On:     09/17/99 11:19 AM
  17.      With Interfacer: 3.0d13   (MPW PowerPC)
  18.      From:    TextEncodingConverter.i
  19.       Revision:  31
  20.       Dated:   3/22/99
  21.       Last change by: PKE
  22.       Last comment: [2247309]  Sonata: Add TECSetBasicOptions API
  23.  
  24.   Bugs:  Report bugs to Radar component "System Interfaces", "Latest"
  25.      List the version information (from above) in the Problem Description.
  26.  
  27. */
  28.  
  29.  
  30. #DEFINE TECPluginSignature AS OSType
  31. #DEFINE TECPluginVersion AS UInt32
  32.  
  33. /* plugin signatures */
  34. BEGIN enum
  35. _kTECSignature               = _"encv"
  36. _kTECUnicodePluginSignature  = _"puni"
  37. _kTECJapanesePluginSignature = _"pjpn"
  38. _kTECChinesePluginSignature  = _"pzho"
  39. _kTECKoreanPluginSignature   = _"pkor"
  40. END ENUM
  41.  
  42. /* converter object reference */
  43. #DEFINE TECObjectRef AS POINTER //TO OpaqueTECObjectRef
  44. #DEFINE TECSnifferObjectRef AS POINTER //TO OpaqueTECSnifferObjectRef
  45. #DEFINE TECPluginSig AS OSType
  46.  
  47. BEGIN RECORD TECConversionInfo
  48. DIM sourceEncoding      AS TextEncoding
  49. DIM destinationEncoding AS TextEncoding
  50. DIM reserved1           AS UInt16
  51. DIM reserved2           AS UInt16
  52. END RECORD
  53.  
  54. LIBRARY "TextEncodingConverter"
  55.  
  56. /* return number of encodings types supported by user's configuraton of the encoding converter */
  57. //EXTERN_API( OSStatus )
  58. TOOLBOX FN TECCountAvailableTextEncodings (ItemCount * numberEncodings)=OSStatus
  59.  
  60. /* fill in an array of type TextEncoding passed in by the user with types of encodings the current configuration of the encoder can handle. */
  61. //EXTERN_API( OSStatus )
  62. TOOLBOX FN TECGetAvailableTextEncodings (TextEncoding availableEncodings[], ItemCount maxAvailableEncodings, ItemCount * actualAvailableEncodings) = OSStatus
  63.  
  64. /* return number of from-to encoding conversion pairs supported  */
  65. //EXTERN_API( OSStatus )
  66. TOOLBOX FN  TECCountDirectTextEncodingConversions (ItemCount * numberOfEncodings) = OSStatus
  67.  
  68. /* fill in an array of type TextEncodingPair passed in by the user with types of encoding pairs the current configuration of the encoder can handle. */
  69. //EXTERN_API( OSStatus )
  70. TOOLBOX FN TECGetDirectTextEncodingConversions (TECConversionInfo availableConversions[], ItemCount maxAvailableConversions, ItemCount * actualAvailableConversions) = OSStatus
  71.  
  72. /* return number of encodings a given encoding can be converter into */
  73. //EXTERN_API( OSStatus )
  74. TOOLBOX FN TECCountDestinationTextEncodings (TextEncoding inputEncoding, ItemCount * numberOfEncodings)=OSStatus
  75.  
  76. /* fill in an array of type TextEncodingPair passed in by the user with types of encodings pairs the current configuration of the encoder can handle. */
  77. //EXTERN_API( OSStatus )
  78. TOOLBOX FN TECGetDestinationTextEncodings (TextEncoding inputEncoding, TextEncoding destinationEncodings[], ItemCount maxDestinationEncodings,ﾂ
  79.        ItemCount *   actualDestinationEncodings)=OSStatus
  80.  
  81. /* get info about a text encoding */
  82. //EXTERN_API( OSStatus )
  83. TOOLBOX FN TECGetTextEncodingInternetName (TextEncoding textEncoding, Str255 encodingName)=OSStatus
  84.  
  85. //EXTERN_API( OSStatus )
  86. TOOLBOX FN TECGetTextEncodingFromInternetName (TextEncoding * textEncoding, Str255 encodingName)=OSStatus
  87.  
  88. /* create/dispose converters */
  89. //EXTERN_API( OSStatus )
  90. TOOLBOX FN TECCreateConverter (TECObjectRef * newEncodingConverter, TextEncoding inputEncoding, TextEncoding outputEncoding)=OSStatus
  91.  
  92. //EXTERN_API( OSStatus )
  93. TOOLBOX FN TECCreateConverterFromPath  (TECObjectRef * newEncodingConverter, const TextEncoding  inPath[], ItemCount inEncodings)=OSStatus
  94.  
  95. //EXTERN_API( OSStatus )
  96. TOOLBOX FN TECDisposeConverter (TECObjectRef newEncodingConverter)=OSStatus
  97.  
  98. /* convert text encodings */
  99. //EXTERN_API( OSStatus )
  100. TOOLBOX FN TECClearConverterContextInfo (TECObjectRef encodingConverter)=OSStatus
  101.  
  102. //EXTERN_API( OSStatus )
  103. TOOLBOX FN TECConvertText (TECObjectRef encodingConverter, ConstTextPtr inputBuffer,ByteCount inputBufferLength, ByteCount * actualInputLength,ﾂ
  104.   TextPtr outputBuffer, ByteCount outputBufferLength, ByteCount * actualOutputLength)=OSStatus
  105.  
  106. //EXTERN_API( OSStatus )
  107. TOOLBOX FN TECFlushText (TECObjectRef encodingConverter, TextPtr outputBuffer, ByteCount outputBufferLength, ByteCount * actualOutputLength)=OSStatus
  108.  
  109. /* one-to-many routines */
  110. //EXTERN_API( OSStatus )
  111. TOOLBOX FN TECCountSubTextEncodings (TextEncoding inputEncoding, ItemCount *   numberOfEncodings)=OSStatus
  112.  
  113. //EXTERN_API( OSStatus )
  114. TOOLBOX FN TECGetSubTextEncodings (TextEncoding inputEncoding, TextEncoding subEncodings[], ItemCount maxSubEncodings, ItemCount * actualSubEncodings)=OSStatus
  115.  
  116. //EXTERN_API( OSStatus )
  117. TOOLBOX FN TECGetEncodingList (TECObjectRef encodingConverter, ItemCount * numEncodings, Handle * encodingList)=OSStatus
  118.  
  119. //EXTERN_API( OSStatus )
  120. TOOLBOX FN TECCreateOneToManyConverter  (TECObjectRef * newEncodingConverter, TextEncoding inputEncoding, ItemCount numOutputEncodings,const TextEncoding  outputEncodings[])=OSStatus
  121.  
  122. //EXTERN_API( OSStatus )
  123. TOOLBOX FN TECConvertTextToMultipleEncodings (TECObjectRef   encodingConverter, ﾂ
  124.   ConstTextPtr inputBuffer,ByteCount inputBufferLength, ByteCount * actualInputLength, ﾂ
  125.   TextPtr outputBuffer, ByteCount outputBufferLength, ByteCount * actualOutputLength, ﾂ
  126.   TextEncodingRun outEncodingsBuffer[], ItemCount maxOutEncodingRuns,ItemCount * actualOutEncodingRun)=OSStatus
  127.  
  128. //EXTERN_API( OSStatus )
  129. TOOLBOX FN TECFlushMultipleEncodings (TECObjectRef encodingConverter,TextPtr outputBuffer,ﾂ
  130.   ByteCount outputBufferLength, ByteCount * actualOutputLength,TextEncodingRun outEncodingsBuffer[],ﾂ
  131.   ItemCount maxOutEncodingRuns,ItemCount * actualOutEncodingRuns)=OSStatus
  132.  
  133. /* international internet info */
  134. //EXTERN_API( OSStatus )
  135. TOOLBOX FN  TECCountWebTextEncodings  (RegionCode locale, ItemCount * numberEncodings)=OSStatus
  136.  
  137. //EXTERN_API( OSStatus )
  138. TOOLBOX FN TECGetWebTextEncodings (RegionCode locale,TextEncoding availableEncodings[],ItemCount maxAvailableEncodings, ItemCount * actualAvailableEncodings)=OSStatus
  139.  
  140. //EXTERN_API( OSStatus )
  141. TOOLBOX FN TECCountMailTextEncodings (RegionCode locale, ItemCount * numberEncodings)=OSStatus
  142.  
  143. //EXTERN_API( OSStatus )
  144. TOOLBOX FN TECGetMailTextEncodings (RegionCode locale, TextEncoding availableEncodings[], ItemCount maxAvailableEncodings, ItemCount * actualAvailableEncodings)=OSStatus
  145.  
  146. /* examine text encodings */
  147. //EXTERN_API( OSStatus )
  148. TOOLBOX FN TECCountAvailableSniffers  (ItemCount * numberOfEncodings)=OSStatus
  149.  
  150. //EXTERN_API( OSStatus )
  151. TOOLBOX FN TECGetAvailableSniffers (TextEncoding availableSniffers[], ItemCount maxAvailableSniffers, ItemCount * actualAvailableSniffers)=OSStatus
  152.  
  153. //EXTERN_API( OSStatus )
  154. TOOLBOX FN TECCreateSniffer (TECSnifferObjectRef * encodingSniffer, TextEncoding testEncodings[], ItemCount numTextEncodings)=OSStatus
  155.  
  156. //EXTERN_API( OSStatus )
  157. TOOLBOX FN TECSniffTextEncoding(TECSnifferObjectRef  encodingSniffer, TextPtr inputBuffer,  ﾂ
  158.   ByteCount inputBufferLength,TextEncoding    testEncodings[], ItemCount numTextEncodings,ﾂ
  159.   ItemCount numErrsArray[], ItemCount maxErrs, ItemCount numFeaturesArray[], ItemCount maxFeatures)=OSStatus
  160.  
  161. //EXTERN_API( OSStatus )
  162. TOOLBOX FN TECDisposeSniffer (TECSnifferObjectRef encodingSniffer)=OSStatus
  163.  
  164. //EXTERN_API( OSStatus )
  165. TOOLBOX FN TECClearSnifferContextInfo (TECSnifferObjectRef encodingSniffer)=OSStatus
  166.  
  167. //EXTERN_API( OSStatus )
  168. TOOLBOX FN TECSetBasicOptions (TECObjectRef encodingConverter ,OptionBits controlFlags)=OSStatus
  169.  
  170. LIBRARY
  171.